/*
 * Copyright (c) 2024 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @addtogroup Drawing
 * @{
 *
 * @brief Drawing模块提供包括2D图形渲染、文字绘制和图片显示等功能函数。\n
 * 本模块采用屏幕物理像素单位px。
 *
 * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing
 *
 * @since 8
 * @version 1.0
 */

/**
 * @file drawing_error_code.h     
 *
 * @brief 声明与绘图模块中的错误码相关的函数。
 *
 * @library libnative_drawing.so
 * @kit ArkGraphics2D
 * @include <native_drawing/drawing_error_code.h>
 * @since 12
 * @version 1.0
 */

#ifndef C_INCLUDE_DRAWING_ERROR_CODE_H
#define C_INCLUDE_DRAWING_ERROR_CODE_H

#include "drawing_types.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief 枚举本模块可能产生的错误码。
 * @since 12
 */
typedef enum {
    /**
     * @error 操作成功完成。
     */
    OH_DRAWING_SUCCESS = 0,
    /**
     * @error 权限校验失败。
     */
    OH_DRAWING_ERROR_NO_PERMISSION = 201,
    /**
     * @error 无效的输入参数，如参数中传入了NULL。
     */
    OH_DRAWING_ERROR_INVALID_PARAMETER = 401,
    /**
     * @error 输入参数不在有效的范围内。
     */
    OH_DRAWING_ERROR_PARAMETER_OUT_OF_RANGE = 26200001,
    /**
     * @error 内存分配失败。
     * @since 13
     */
    OH_DRAWING_ERROR_ALLOCATION_FAILED = 26200002,
    /**
     * @error 输入属性id无匹配的函数。
     * @since 21
     */
    OH_DRAWING_ERROR_ATTRIBUTE_ID_MISMATCH = 26200003,
} OH_Drawing_ErrorCode;

/**
 * @brief 获取本模块的错误码。
 *
 * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing
 * @return 获取本模块的最近一次的错误码。当函数成功运行后，本函数返回的错误码不会被修改。
 * @since 12
 * @version 1.0
 */
OH_Drawing_ErrorCode OH_Drawing_ErrorCodeGet();

/**
 * @brief 将本模块的错误码重置为OH_DRAWING_SUCCESS。\n
 * 通过{@link OH_Drawing_ErrorCodeGet}获取的本模块错误码会在不以错误码为返回值的接口执行失败时被置为对应的错误编号，但是不会在执行成功后被重置为OH_DRAWING_SUCCESS。\n
 * 调用本接口可将错误码重置为OH_DRAWING_SUCCESS，避免多个接口间互相干扰，方便开发者调试。
 *
 * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing
 * @since 18
 * @version 1.0
 */
void OH_Drawing_ErrorCodeReset(void);

#ifdef __cplusplus
}
#endif
/** @} */
#endif